Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More ruby documentation; prototype general model.rb add methods #1840

Merged
merged 46 commits into from
Sep 30, 2024

Conversation

joseph-robertson
Copy link
Collaborator

@joseph-robertson joseph-robertson commented Sep 19, 2024

Pull Request Description

Addresses #1759.

Also starts prototyping generic Model.add_foo to model.rb to consolidate code that creates OSM objects. It makes the objects easier to use, and it allows us to introduce additional logic that applies to every object of the same type (like using EMS-friendly variable names or avoiding the need for a developer to remember to use .to_s on an object name to get a string).

Checklist

Not all may apply:

  • Schematron validator (EPvalidator.xml) has been updated
  • Sample files have been added/updated (openstudio tasks.rb update_hpxmls)
  • Tests have been added/updated (e.g., HPXMLtoOpenStudio/tests/test*.rb and/or workflow/tests/test*.rb)
  • Documentation has been updated
  • Changelog has been updated
  • openstudio tasks.rb update_measures has been run
  • No unexpected changes to simulation results of sample files

HPXMLtoOpenStudio/resources/meta_measure.rb Outdated Show resolved Hide resolved
HPXMLtoOpenStudio/resources/meta_measure.rb Outdated Show resolved Hide resolved
HPXMLtoOpenStudio/resources/meta_measure.rb Outdated Show resolved Hide resolved
@joseph-robertson joseph-robertson self-assigned this Sep 20, 2024
@joseph-robertson
Copy link
Collaborator Author

@shorowit Can you fill in remaining TODOs for apply_foundation_wall and apply_foundation_slab in HPXMLtoOpenStudio/resources/geometry.rb? I think they are related to kiva.

@shorowit
Copy link
Contributor

@shorowit Can you fill in remaining TODOs for apply_foundation_wall and apply_foundation_slab in HPXMLtoOpenStudio/resources/geometry.rb? I think they are related to kiva.

Done.

@shorowit shorowit changed the title More ruby documentation More ruby documentation; create model.rb methods Sep 27, 2024
@shorowit shorowit changed the title More ruby documentation; create model.rb methods More ruby documentation; create general model.rb add methods Sep 27, 2024
@shorowit shorowit changed the title More ruby documentation; create general model.rb add methods More ruby documentation; prototype general model.rb add methods Sep 27, 2024
@shorowit shorowit marked this pull request as ready for review September 29, 2024 20:00
@shorowit shorowit merged commit 54ca3ac into master Sep 30, 2024
7 checks passed
@shorowit shorowit deleted the ruby-docs branch September 30, 2024 04:55
@joseph-robertson joseph-robertson mentioned this pull request Oct 3, 2024
22 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants